[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
##############################################################################
###+-----------+##############################################################
#+-| BITTEST() |-------------------------------------------------+############
#| +-----------+ Returns TRUE if the Nth bit in a variable is on |############
#+---------------------------------------------------------------+############
##############################################################################
##############################################################################
#+--| Summary |--------------+################################################
#|     #INCLUDE math.hdr     |################################################
#+---------------------------+################################################
##############################################################################
##############################################################################
#+--| Syntax |----------------------------------------------+#################
#|     FUNCTION LOGICAL bittest PROTOTYPE                   |#################
#|      PARAMETERS UNTYPED param, VALUE UINT bit_number     |#################
#+----------------------------------------------------------+#################
##############################################################################
##############################################################################
#######+---| Description |--------------------------------------------+#######
#######| The bittest() function returns TRUE if the bit_number bit    |#######
#######| within param is set.                                         |#######
#######| ------------------------------------------------------------ |#######
#######| bit_number is zero based.  That is, the 1st bit within param |#######
#######| is considered bit 0 and is the low order bit.  bit_number    |#######
#######| may range from 0 to 31.                                      |#######
#######+--------------------------------------------------------------+#######
##############################################################################
##############################################################################
#########+--| Example 1 |-------------------------------------------+#########
#########| *    some results from bittest                           |#########
#########|                                                          |#########
#########| k = 1                                                    |#########
#########| ? bittest( k, 0 )              && returns .T.            |#########
#########| k = -2                                                   |#########
#########| ? bittest( k, 0 )              && returns .F.            |#########
#########+----------------------------------------------------------+#########
##############################################################################
##############################################################################
#########+--| Example 2 |-------------------------------------------+#########
#########| *    See if a "skeleton" is a directory name.            |#########
#########|                                                          |#########
#########| IF find_first("abc", 0x3f )                              |#########
#########|     IF bittest( find_fattr(), 5 )                        |#########
#########|         ? "Abc is a directory"                           |#########
#########|     ELSE                                                 |#########
#########|         ? "Abc is NOT a directory"                       |#########
#########|     ENDIF                                                |#########
#########| ENDIF                                                    |#########
#########+----------------------------------------------------------+#########
##############################################################################

See Also: bitset
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson